User classes expose typed-signal API even without #[signal]#1146
Merged
User classes expose typed-signal API even without #[signal]#1146
#[signal]#1146Conversation
…declared Necessary due to `&mut self` forwarding, which base collections with Gd<T> can't do. See comments for details.
Bromeon
added
quality-of-life
#[hint] should really be hints: injecting information that the proc-macro cannot infer, like with #[hint(no_base)] fields. We could use #[hint(has_base_field = true, class_visibility = pub)] or so in the future. For now, disabling entire typed-signal API (including traits) can be done on #[godot_api] itself.
Bromeon
force-pushed
the
qol/withsignals-everywhere
branch
from
2f97138 to
99b76e6
Compare
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-1146 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Previously, you needed at least one
#[signal]to make yourGodotClasseligible for theWithUserSignalstrait, meaning otherwise you couldn't accessself.signals()orGd::signals()methods. This made sense while at the time, but with implicit access to base signals, this can now be relaxed.The new rule is: typed signals are enabled if your class has a
Base<T>field. This still allows to use lightweight data classes without base fields.This PR also provides a blanked opt-out for typed signals:
This should be rarely needed, but can be helpful in situations where proc-macro API causes problems (e.g.
impl nested::MyClass) or excessive code generation. If enabled,#[signal]can still be used and will register the signal, but not generate any typed APIs -- just like in v0.2.